/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package org.apache.bifromq.basescheduler;

import java.util.concurrent.CompletableFuture;

/**
 * Interface for batch call scheduler.
 *
 * @param <ReqT>  the type of the request to be fulfilled in batch
 * @param <RespT> the type of the response expected
 */
public interface IBatchCallScheduler<ReqT, RespT> {
    /**
     * Schedule a request to be fulfilled in batch.
     *
     * @param request the request to be fulfilled in batch
     * @return a future which will complete when the request is fulfilled
     */
    CompletableFuture<RespT> schedule(ReqT request);

    /**
     * Close the batch call scheduler and release any resources associated.
     */
    void close();
}
